package org.easy.excel.support.annotations;

import java.lang.annotation.*;

/**
 * 导出列标记注解
 *
 * @author 李坤
 * @date 2022/4/24 21:36
 */
@Documented
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface ExportTopLabel {

    String DEFAULT_SHEET_NAME = "sheet";

    /**
     * Excel 顶级标题
     *
     * @return 名称
     */
    String value() default "";

    /**
     * 导出文件的文件名称
     *
     * @return 文件名称
     */
    String fileName() default "";

    /**
     * 默认的 sheet 名称
     *
     * @return sheet名称
     */
    String sheetName() default DEFAULT_SHEET_NAME;

    /**
     * 标题所占高度
     *
     * @return 高度
     */
    int highly() default 1;

    /**
     * 是否在首列添加序列
     *
     * @return 是否添加序列
     */
    boolean appendSequence() default false;

}
